Skip to content

docs: fix CONTRIBUTING.md to match actual repo configuration#17

Merged
atsyplikhin merged 1 commit intomainfrom
docs/fix-contributing-guide
Apr 9, 2026
Merged

docs: fix CONTRIBUTING.md to match actual repo configuration#17
atsyplikhin merged 1 commit intomainfrom
docs/fix-contributing-guide

Conversation

@atsyplikhin
Copy link
Copy Markdown
Collaborator

@atsyplikhin atsyplikhin commented Apr 9, 2026

Summary

  • Fork workflow: replaced git clone + git push origin (requires write access) with gh repo fork --clone + gh pr create --fill, with manual fallbacks in collapsible <details> sections
  • Python version: 3.10+ → 3.11+ to match all three pyproject.toml requires-python constraints
  • Test commands: fixed broken cd chaining in unit tests, added 2 missing agent-tools test files (test_langchain_adapter.py, test_strands_adapter.py) to match CI, simplified integration test invocation
  • Linting: created ruff.toml with line-length = 120 (previously claimed but unconfigured), added lint step to workflow and PR checklist
  • asyncio_mode: corrected blanket auto claim — agent-tools uses strict, documented accurately
  • Structure: merged duplicated setup/fork sections into a single unified Development Setup flow

Test plan

  • ruff check packages/ tests/ passes with new ruff.toml in place
  • Verify every shell command in the doc can be pasted directly from repo root
  • Confirm gh repo fork --clone flow works for a non-collaborator GitHub account

- Use fork-based workflow (gh repo fork) instead of assuming push
  access to upstream, with manual fallback in collapsible sections
- Fix Python version: 3.10+ → 3.11+ to match pyproject.toml
- Fix unit test commands: run from repo root instead of broken cd
  chaining, add missing agent-tools test files to match CI
- Fix integration test command: drop redundant path arg, use pytest
  directly to match CI
- Add ruff.toml with line-length=120 to back the coding standards claim
- Add "Lint & test" step to contributor workflow
- Add ruff check to PR checklist
- Fix asyncio_mode docs: note it varies by package (auto vs strict)
- Merge duplicated setup/fork sections into single Development Setup
@atsyplikhin atsyplikhin merged commit bf42d97 into main Apr 9, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants